package com.xianyl.libsforandroid.utils;

import android.content.Context;
import android.content.SharedPreferences;

/**
 * Preferences工具类
 * <ul>
 * <strong>Preference 的名字</strong>
 * <li>能在 {@link #PREFERENCE_NAME} 改变 preference 的名字</li>
 * </ul>
 * <ul>
 * <strong>放值</strong>
 * <li>put string {@link #putString(Context, String, String)}</li>
 * <li>put int {@link #putInt(Context, String, int)}</li>
 * <li>put long {@link #putLong(Context, String, long)}</li>
 * <li>put float {@link #putFloat(Context, String, float)}</li>
 * <li>put boolean {@link #putBoolean(Context, String, boolean)}</li>
 * </ul>
 * <ul>
 * <strong>取值</strong>
 * <li>get string {@link #getString(Context, String)}, {@link #getString(Context, String, String)}</li>
 * <li>get int {@link #getInt(Context, String)}, {@link #getInt(Context, String, int)}</li>
 * <li>get long {@link #getLong(Context, String)}, {@link #getLong(Context, String, long)}</li>
 * <li>get float {@link #getFloat(Context, String)}, {@link #getFloat(Context, String, float)}</li>
 * <li>get boolean {@link #getBoolean(Context, String)}, {@link #getBoolean(Context, String, boolean)}</li>
 * </ul>
 * 
 * @author xianyl
 */
public class PreferencesUtils {

	/** 默认Preferences的名称**/
    public static String PREFERENCE_NAME = "PreferenceName_xianyl";
    
    /**
     * 获取SharedPreferences
     * @param context
     * @param name SharedPreferences的名字   传入null 使用默认的
     * @param mode SharedPreferences的模式 {@link Context#getSharedPreferences(String, int)}
     * @return
     */
    public static SharedPreferences getSharedPreferences(Context context, String name, int mode){
    	return context.getSharedPreferences(name==null?PREFERENCE_NAME:name, mode);
    }
    
    

    /**
     * 删除一个键的值 
     * @param context
     * @param key preferences 里面key字段
     * @return 如果成功修改返回true
     */
    public static boolean remove(Context context, String key) {
    	SharedPreferences settings = getSharedPreferences(context, null, Context.MODE_PRIVATE);
    	SharedPreferences.Editor editor = settings.edit();
    	editor.remove(key);
    	return editor.commit();
    }
    /**
     * 放字符串进入preferences
     * 
     * @param context
     * @param key preferences 里面key字段
     * @param value preferences 里面value字段
     * @return 如果新值写入持久存储返回true
     */
    public static boolean putString(Context context, String key, String value) {
        SharedPreferences settings = getSharedPreferences(context, null, Context.MODE_PRIVATE);
        SharedPreferences.Editor editor = settings.edit();
        editor.putString(key, value);
        return editor.commit();
    }

    /**
     * 获取preferences里面key对应的value字符串，如果没有，返回null
     * 
     * @param context
     * @param key 
     * @return 
     * @see #getString(Context, String, String)
     */
    public static String getString(Context context, String key) {
        return getString(context, key, null);
    }

    /**
     * 获取preferences里面key对应的value字符串
     * 
     * @param context
     * @param key preferences 里面key字段名称
     * @param defaultValue 如果没有，需要返回的字符串
     * @return
     */
    public static String getString(Context context, String key, String defaultValue) {
        SharedPreferences settings = getSharedPreferences(context, null, Context.MODE_PRIVATE);
        return settings.getString(key, defaultValue);
    }

    /**
     * 放整型进入preferences
     * 
     * @param context
     * @param key preferences 里面key字段
     * @param value preferences 里面value字段
     * @return 如果新值写入持久存储返回true
     */
    public static boolean putInt(Context context, String key, int value) {
        SharedPreferences settings = getSharedPreferences(context, null, Context.MODE_PRIVATE);
        SharedPreferences.Editor editor = settings.edit();
        editor.putInt(key, value);
        return editor.commit();
    }

    /**
     * 获取preferences里面key对应的value整型，如果没有，默认为-1
     * 
     * @param context
     * @param key 
     * @return 
     * @see #getInt(Context, String, int)
     */
    public static int getInt(Context context, String key) {
        return getInt(context, key, -1);
    }

    /**
     * 获取preferences里面key对应的value整型
     * 
     * @param context
     * @param key preferences 里面key字段名称
     * @param defaultValue 如果没有，需要返回的整型
     * @return
     */
    public static int getInt(Context context, String key, int defaultValue) {
        SharedPreferences settings = getSharedPreferences(context, null, Context.MODE_PRIVATE);
        return settings.getInt(key, defaultValue);
    }

    /**
     * 放长整型进入preferences
     * 
     * @param context
     * @param key preferences 里面key字段
     * @param value preferences 里面value字段
     * @return 如果新值写入持久存储返回true
     */
    public static boolean putLong(Context context, String key, long value) {
        SharedPreferences settings = getSharedPreferences(context, null, Context.MODE_PRIVATE);
        SharedPreferences.Editor editor = settings.edit();
        editor.putLong(key, value);
        return editor.commit();
    }

    /**
     * 获取preferences里面key对应的value长整型，如果没有，默认为-1
     * 
     * @param context
     * @param key 
     * @return  
     * @see #getLong(Context, String, long)
     */
    public static long getLong(Context context, String key) {
        return getLong(context, key, -1);
    }

    /**
     * 获取preferences里面key对应的value长整型
     * 
     * @param context
     * @param key preferences 里面key字段名称
     * @param defaultValue 如果没有，需要返回的长整型
     * @return
     */
    public static long getLong(Context context, String key, long defaultValue) {
        SharedPreferences settings = getSharedPreferences(context, null, Context.MODE_PRIVATE);
        return settings.getLong(key, defaultValue);
    }

    /**
     * 放浮点型进入preferences
     * 
     * @param context
     * @param key preferences 里面key字段
     * @param value preferences 里面value字段
     * @return 如果新值写入持久存储返回true
     */
    public static boolean putFloat(Context context, String key, float value) {
        SharedPreferences settings = getSharedPreferences(context, null, Context.MODE_PRIVATE);
        SharedPreferences.Editor editor = settings.edit();
        editor.putFloat(key, value);
        return editor.commit();
    }

    /**
     * 获取preferences里面key对应的value浮点型，如果没有，默认为-1
     * 
     * @param context
     * @param key 
     * @return  
     * @see #getFloat(Context, String, float)
     */
    public static float getFloat(Context context, String key) {
        return getFloat(context, key, -1);
    }

    /**
     * 获取preferences里面key对应的value浮点型
     * 
     * @param context
     * @param key preferences 里面key字段名称
     * @param defaultValue 如果没有，需要返回的浮点型
     * @return
     */
    public static float getFloat(Context context, String key, float defaultValue) {
        SharedPreferences settings = getSharedPreferences(context, null, Context.MODE_PRIVATE);
        return settings.getFloat(key, defaultValue);
    }

    /**
     * 放布尔类型进入preferences
     * 
     * @param context
     * @param key preferences 里面key字段
     * @param value preferences 里面value字段
     * @return 如果新值写入持久存储返回true
     */
    public static boolean putBoolean(Context context, String key, boolean value) {
        SharedPreferences settings = getSharedPreferences(context, null, Context.MODE_PRIVATE);
        SharedPreferences.Editor editor = settings.edit();
        editor.putBoolean(key, value);
        return editor.commit();
    }

    /**
     * 获取preferences里面key对应的value布尔类型，如果没有，默认为 false
     * 
     * @param context
     * @param key 
     * @return 
     * @see #getBoolean(Context, String, boolean)
     */
    public static boolean getBoolean(Context context, String key) {
        return getBoolean(context, key, false);
    }

    /**
     * 获取preferences里面key对应的value布尔类型
     * 
     * @param context
     * @param key preferences 里面key字段名称
     * @param defaultValue 如果没有，需要返回的布尔类型
     * @return
     */
    public static boolean getBoolean(Context context, String key, boolean defaultValue) {
        SharedPreferences settings = getSharedPreferences(context, null, Context.MODE_PRIVATE);
        return settings.getBoolean(key, defaultValue);
    }
}
